Readme integrations to docs update#1818
Conversation
|
Excellent, I love this. My only comment is that it's too far down on the page and might be missed by users. |
Yes I think we should just have it after What Can Robusta Do?. Other stuff will go down, but it's fine. |
WalkthroughA detailed "Integrations" section was added to the README, categorizing and listing supported integrations with logos and documentation links. Minor textual corrections and "back to top" links were introduced. A commented-out installation options table was included. No changes were made to code or exported entities; all modifications are documentation enhancements. Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
33-36: Add "Integrations" Section
Great addition—placing the Integrations section immediately after the “What Can Robusta Do?” content makes it highly discoverable. Consider tightening the intro copy by replacing “a variety of tools and platforms” with a more concise synonym (e.g., “various tools and platforms”).🧰 Tools
🪛 LanguageTool
[style] ~35-~35: Consider using a more concise synonym.
Context: ...? Integrations Robusta integrates with a variety of tools and platforms. Click on any logo ...(A_VARIETY_OF)
357-359: Use Consistent Markdown List Style
The Free Robusta UI bullets use dashes, but earlier lists use asterisks. For consistency and to satisfy markdownlint, switch to asterisk bullets:- - **AI Assistant**: Solve alerts faster with an AI assistant that highlights relevant observability data - - **Alert Timeline**: View Prometheus alerts across multiple clusters and spot correlations with a powerful timeline view - - **Change Tracking**: Correlate alerts with changes to your infrastructure or applications, with Robusta's automatic change tracking for Kubernetes + * **AI Assistant**: Solve alerts faster with an AI assistant that highlights relevant observability data + * **Alert Timeline**: View Prometheus alerts across multiple clusters and spot correlations with a powerful timeline view + * **Change Tracking**: Correlate alerts with changes to your infrastructure or applications, with Robusta's automatic change tracking for Kubernetes🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
357-357: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
358-358: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
359-359: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (61)
docs/images/integration_logos/aks-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/anthropic-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/argocd-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/aws-managed-prometheus-logo.svgis excluded by!**/*.svgdocs/images/integration_logos/azure-managed-prometheus.pngis excluded by!**/*.pngdocs/images/integration_logos/bash-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/coralogix-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/datadog-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/discord-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/dynatrace-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/eks-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/file-icon.svgis excluded by!**/*.svgdocs/images/integration_logos/gcpmonitoring-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/gemini-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/github-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/gitlab-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/gke-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/google_chat-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/grafana-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/grafana_loki-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/grafana_oncall-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/graylog-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/http-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/incidentio-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/jira-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/kafka-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/kafka-logo.pngis excluded by!**/*.pngdocs/images/integration_logos/kibana-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/kubernetes-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/litellm-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/llamacpp-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/mattermost-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/newrelic-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/ollama-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/openai-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/opensearchserverless-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/openshift-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/opsgenie-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/pagerduty-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/postgres-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/prometheus-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/psql-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/pushover-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/python-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/rocketchat-logo.svgis excluded by!**/*.svgdocs/images/integration_logos/servicenow-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/slack-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/smtp-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/smtp-logo.pngis excluded by!**/*.pngdocs/images/integration_logos/ssh-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/teams-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/telegram-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/thanos-logo.svgis excluded by!**/*.svgdocs/images/integration_logos/victoriametrics-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/victoriametrics-logo.pngis excluded by!**/*.pngdocs/images/integration_logos/victorops-logo.svgis excluded by!**/*.svgdocs/images/integration_logos/webex-logo.pngis excluded by!**/*.pngdocs/images/integration_logos/webhook-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/websocket-icon.pngis excluded by!**/*.pngdocs/images/integration_logos/yandex-logo.svgis excluded by!**/*.svgdocs/images/integration_logos/zabbix-icon.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~35-~35: Consider using a more concise synonym.
Context: ...? Integrations Robusta integrates with a variety of tools and platforms. Click on any logo ...
(A_VARIETY_OF)
🪛 markdownlint-cli2 (0.17.2)
README.md
357-357: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
358-358: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
359-359: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
362-362: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: run_tests
- GitHub Check: run_tests
- GitHub Check: Deploy docs
🔇 Additional comments (6)
README.md (6)
37-180: Add Notification Destinations Table
The new “Notification Destinations” table is comprehensive and the logos all include alt text for accessibility. The layout and link formatting are consistent with the rest of the README.
182-243: Add Metrics and Alerts Table
Well-structured list of metrics backends. The images and links are correct and maintain the existing style.
245-263: Add AI & Cost Management Table
This concise table clearly highlights AI and cost-management integrations. Good use of external logo for HolmesGPT.
264-264: Add Back-to-Top Link After Integrations
Including a “back to top” anchor here improves navigation, especially given the length of the integrations content.
295-351: The commented-out “Installation Options” block is intentionally pending; skipping review of this section.
365-365: Add Back-to-Top Link After Free Robusta UI
Consistent with other sections, this “back to top” link helps readers navigate the document.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
302-358: Commented-out Installation Options should be clarifiedThe commented-out Installation Options block is pending future activation. To maintain clarity and avoid confusing readers, consider adding a
TODOnote explaining its status or moving this draft into a separate file until it's ready for use.
364-366: Use consistent bullet list styleLines 364–366 currently use hyphens (
-) for list items, but elsewhere in the README asterisks (*) are used. Please switch to asterisks to align with the project’s existing Markdown conventions.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
364-364: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
365-365: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
366-366: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
369-369: Add alt text to the inline imageThe image on line 369 lacks an alt attribute, which impacts accessibility and fails Markdown lint rules. For example:
-  + 🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
369-369: Images should have alternate text (alt text)
null(MD045, no-alt-text)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~35-~35: Consider using a more concise synonym.
Context: ...? Integrations Robusta integrates with a variety of tools and platforms. Click on any logo ...
(A_VARIETY_OF)
🪛 markdownlint-cli2 (0.17.2)
README.md
364-364: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
365-365: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
366-366: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
369-369: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: run_tests
- GitHub Check: run_tests
🔇 Additional comments (2)
README.md (2)
33-180: Comprehensive Integrations section added in correct locationThe newly introduced Integrations section is well-organized into distinct categories and placed immediately after the "What Can Robusta Do?" header, improving discoverability as suggested in the PR discussion. All links and logo assets appear correctly referenced.
🧰 Tools
🪛 LanguageTool
[style] ~35-~35: Consider using a more concise synonym.
Context: ...? Integrations Robusta integrates with a variety of tools and platforms. Click on any logo ...(A_VARIETY_OF)
372-372: Confirm “back to top” consistencyThe new
<p align="right">(<a href="#top">back to top</a>)</p>follows the pattern used elsewhere in the document and improves navigation. No action needed here.
2 participants
Part of updating the Readme, will add more changes in other PR's.
Make it easy for users to understand which of their tools we support, and also get them to relevant docs faster.
Note: Installation options is commented for now (waiting for some suggestions about it, but that need not delay this PR)
Summary by CodeRabbit